<html><head><title>Agate Rule Tester Help</title>

<link type = "text/css" rel = "stylesheet" href = "main.css">

</head>

<body>

<table width = "80%" border = "0" cellspacing = "0" cellpadding = "2" class = "titlebar">
<tr>
    <td class = "breadcrumbs">
    	<a href = "index.html">Home</a> -&gt; Introduction
    </td>
</tr>
<tr>
	<td class = "title">
		<div id = "sectionTitle">Meet the Tester Interface</div>
		<div id = "icon"><img src = "agate48.png"></div>
	</td>
</tr>
</table>

<div id = "content">
The interface for the Agate Rule Tester consists of two windows: the main rule input window where rules are placed 
and controls for operating tests are located.  And the Translated Text window which shows the results of said 
rules and operation of controls.
<p align = "center">
<img src = "screenshots/intro1.png" align = "center">
<p>
The text view is not directly editable, but is selectable.  The majority of your time will be spent interfacing with 
the rule input window, which should look somewhat familiar to DT's SpeedManager interface.  New, Edit, Duplicate, 
Delete, and Run Rules all do what one would imagine.  "Show DT Mnemonics" will toggle the visibility of special 
characters as their mnemonic version (e.g., a tab will show up as [TAB], emdash will be [EMDASH], and so on).  The up
and down arrows on the right modify rule order.
<p>
Tester-specific items are the "Active" column in the rulelist that will present a checkbox that will turn a rule
on or off and the "Base loaded:" label that will indicate which <a href = "base_translations.html">base ruleset</a> 
is loaded and how many rules are in said ruleset.
<p>
The rule creation and editing sheet should also look somewhat familiar.
<p align = "center">
<img src = "screenshots/intro2.png">
<p>
Every attempt has been made to replicate the functionality of the SpeedManager interface, including such things 
as [$##] placeholders, using [#perl] to denote a regular expression, split regex logic (where both find and replace
fields are regular expressions), syntax error checking, and automatic mnemonic replacement of special characters 
upon save.  All checkbox options operate exactly as their SpeedManager counterparts.
<p>
There is one additional item on the rule edit screen that isn't displayed in this screen, and that is when 
you generate a syntax error in your regular expression.  Errors are displayed in red in the space between the
find and replace boxes.  These errors will indicate which part of the rule is at fault and will display the exact
error perl returned from its evaluation (which is both good and bad, as the errors can be somewhat... obscure).
<p>
Finally, there is the About window, which is important to note as it the only location where the version number 
is display.  This number is <strong>required</strong> when reporting problems or requesting feature additions.
<p align = "center">
<img src = "screenshots/intro3.png">
</p>
</div>

<div id = "menu">
    <div id = "menuTitle">Help Contents:</div>
	<div id = "menuContents">
		<a href = "index.html">Home</a><br>
		Meet the Tester Interface<br>
		<a href = "base_translations.html">Creating Base Translations</a><br>
		<a href = "what_you_need.html">Resources and Notes</a><br>
		<a href = "issues_limitations.html">Known Issues/Bugs/Limitations</a>
	</div>
</div>
</body>
</html>
